Developer Documentation

QuickTime 4 API Documentation

3D Graphics Programming with QuickDraw 3D 1.5.4

Previous | QD3D Book | Overview | Chapter Contents | Next |

Managing Highlight Styles

QuickDraw 3D provides routines that you can use to manage highlight styles.

Q3HighlightStyle_New

You can use the Q3HighlightStyle_New function to create a new highlight style object.

TQ3StyleObject Q3HighlightStyle_New (
                     TQ3AttributeSet highlightAttribute);
highlightAttribute
An attribute set.

DESCRIPTION

The Q3HighlightStyle_New function returns, as its function result, a new style object having the highlight style specified by the highlightAttribute parameter. The highlightAttribute parameter should be a reference to an attribute set.

If a new style object could not be created, Q3HighlightStyle_New returns the value NULL .

To change the current highlight style, you must actually draw the style object. You can call Q3Style_Submit to draw the style in retained mode or Q3HighlightStyle_Submit (described next) to draw the style in immediate mode.

SEE ALSO

See "Highlight Styles" for a description of highlight styles.

Q3HighlightStyle_Submit

You can use the Q3HighlightStyle_Submit function to submit a highlight style in immediate mode.

TQ3Status Q3HighlightStyle_Submit (
                     TQ3AttributeSet highlightAttribute,
                     TQ3ViewObject view);
highlightAttribute
An attribute set.
view
A view.

DESCRIPTION

The Q3HighlightStyle_Submit function sets the highlight style of the view specified by the view parameter to the style specified in the highlightAttribute parameter.

SPECIAL CONSIDERATIONS

You should call Q3HighlightStyle_Submit only in a submitting loop.

Q3HighlightStyle_Get

You can use the Q3HighlightStyle_Get function to get the highlight style value of a highlight style.

TQ3Status Q3HighlightStyle_Get (
                     TQ3StyleObject highlight,
                     TQ3AttributeSet *highlightAttribute);
highlight
A highlight style object.
highlightAttribute
On exit, a pointer to the attribute set of the specified highlight style object.

DESCRIPTION

The Q3HighlightStyle_Get function returns, in the highlightAttribute parameter, a pointer to the current attribute set of the style object specified by the highlight parameter.

Q3HighlightStyle_Set

You can use the Q3HighlightStyle_Set function to set the highlight style value of a highlight style.

TQ3Status Q3HighlightStyle_Set (
                     TQ3StyleObject highlight,
                     TQ3AttributeSet highlightAttribute);
highlight
A highlight style object.
highlightAttribute
An attribute set.

DESCRIPTION

The Q3HighlightStyle_Set function sets the highlight style value of the style object specified by the highlight parameter to the attribute set specified in the highlightAttribute parameter.

© 1997 Apple Computer, Inc.

Previous | QD3D Book | Overview | Chapter Contents | Next |